﻿///////////////////////////////////////////////////////////////////////////////
//
//  This source is part of the  "Managed Task Framework.NET Runtime"  (MTF.NET Runtime).
//
//
//  Copyright (c) 2011, Multicore Consulting Limited (UK)
//  All rights reserved.
//  http://www.multicoreconsulting.co.uk
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions
//  are met:
//
//  -  Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
//  -  Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in
//     the documentation and/or other materials provided with the
//     distribution.
//  -  Neither the name of Multicore Consulting Limited nor the names of
//     its contributors may be used to endorse or promote products
//     derived from this software without specific prior written
//     permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
//  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
//  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
//  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
//  COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
//  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
//  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
//  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
//  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
//  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
//  POSSIBILITY OF SUCH DAMAGE.
//
///////////////////////////////////////////////////////////////////////////////

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace MTFOrg.MTF.MTFRuntime
{
    /// <summary>
    /// Specifies whether the connection is owned locally or by
    /// the remote task.
    /// </summary>
    public enum ConnectionType
    {
        OwnedConnection,
        RemoteConnection
    }

    /// <summary>
    /// Decorates an IConnection to provide information about
    /// which end owns the connection.
    /// </summary>
    public class LocatedConnection : IConnection
    {
        /// <summary>
        /// Type of this connection.
        /// </summary>
        protected ConnectionType m_ConnectionType;

        /// <summary>
        /// Decorated connection.
        /// </summary>
        protected IConnection m_Connection;

        /// <summary>
        /// Connection point that receives messages sent on this connection.
        /// </summary>
        protected IConnectionPoint m_ReceiverConnectionPoint;

        /// <summary>
        /// User data tag.
        /// </summary>
        protected object m_Tag;

        /// <summary>
        /// Constructor.
        /// </summary>
        /// <param name="connection">Connection to decorate</param>
        /// <param name="connectionType">Type of the decorated connection</param>
        public LocatedConnection(IConnection connection, ConnectionType connectionType)
        {
            m_Connection = connection;
            m_ConnectionType = connectionType;

            m_ReceiverConnectionPoint =
                (connectionType == ConnectionType.OwnedConnection) ?
                connection.TargetConnectionPoint : connection.SourceConnectionPoint;
        }

        /// <summary>
        /// Gets the type of this connection.
        /// </summary>
        public ConnectionType ConnectionType
        {
            get { return m_ConnectionType; }
        }

        /// <summary>
        /// Gets the connection point from which this connection was made.
        /// </summary>
        public IConnectionPoint SourceConnectionPoint
        {
            get { return m_Connection.SourceConnectionPoint; }
        }

        /// <summary>
        /// Gets the ordering value for the source end of the connection.
        /// </summary>
        public int SourceOrder
        {
            get { return m_Connection.SourceOrder; }
        }

        /// <summary>
        /// Gets the connection point to which this connection was made
        /// </summary>
        public IConnectionPoint TargetConnectionPoint
        {
            get { return m_Connection.TargetConnectionPoint; }
        }

        /// <summary>
        /// Gets the ordering value for the target end of the connection.
        /// </summary>
        public int TargetOrder
        {
            get { return m_Connection.TargetOrder; }
        }

        /// <summary>
        /// Gets the connection point that receives messages sent on this connection.
        /// </summary>
        public IConnectionPoint ReceiverConnectionPoint
        {
            get { return m_ReceiverConnectionPoint; }
        }

        /// <summary>
        /// Gets the unique identifier for this connection.
        /// </summary>
        public Guid Id
        {
            get { return m_Connection.Id; }
        }

        /// <summary>
        /// User data tagged onto this connection.
        /// </summary>
        public object Tag
        {
            get { return m_Tag; }
            set { m_Tag = value; }
        }

        /// <summary>
        /// Gets the task that owns this connection.
        /// </summary>
        public ITask ParentTask
        {
            get { return m_Connection.ParentTask; }
        }

        /// <summary>
        /// Gets the property with the specified name.
        /// </summary>
        /// <param name="name">Name of property to retrieve</param>
        /// <returns>Property with specified name</returns>
        public ConnectionProperty GetProperty(string name)
        {
            return m_Connection.GetProperty(name);
        }
    }
}
